home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 18 / CU Amiga Magazine's Super CD-ROM 18 (1997)(EMAP Images)(GB)[!][issue 1998-01].iso / CUCD / Programming / ARexxGuide / OS2.x_Version / ARexxGde2_0rqA.readme next >
Text File  |  1994-10-08  |  12KB  |  252 lines
  1. Short: ARexx ref & tutorial. ReqTools ver.
  2. Short: Complete ARexx reference. AmigaGuide.
  3. Type: util/rexx
  4. Uploader: robin@halcyon.com
  5. Author: Robin Evans
  6.  
  7. Keywords: ARexx,manual,reference,tutorial,AmigaGuide,script,TurboText,Edge,Ed
  8.  
  9.  DESCRIPTION
  10.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  11. This is the RQ version of ARexxGuide. It works properly only with
  12. v34 of the AmigaGuide viewer (pre-3.0 versions) and requires
  13. rexxreqtools.library and reqtools.library. The libraries are not
  14. included, but should be available wherever ARexxGuide is found.
  15.  
  16. The standard version (ARexxGuide2_0A.lha) does not require the
  17. libraries and includes text formatting codes for Multiview users.
  18.  
  19. ARexxGuide is a complete ARexx reference with tutorials and dozens
  20. of ready-to-use examples. Done in AmigaGuide format, it includes
  21. argument templates and descriptions of all instruction keywords, of
  22. built-in functions, and of the functions in rexxsupport.library.
  23. The basic elements of the language are fully explained. Example
  24. programs -- some of them interactive -- answer frequently-asked
  25. questions about the language. Sample clauses are included with each
  26. function and instruction explanation. Error codes and possible
  27. solutions are explained.
  28.  
  29. A help-system that will turn nearly any text editor into an online
  30. reference to ARexx is included. Working macros for three editors
  31. are provided as examples. A step-by-step tutorial explains the
  32. simple steps for making a new macro for a different editor.
  33.  
  34. ARexxGuide is a shareware offering. The suggested fee is $15.
  35.  
  36.  VERSION
  37.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  38. 2.0a: Some embarrasing problems in the included scripts are fixed.
  39.       Those who previously downloaded the 2.0 version can get
  40.       copies of the fixed scripts in the archive ARexxG_20patch.lha.
  41.  
  42. The second edition includes extensive changes thoughout. Two new
  43. tutorials explain ARexx as a macro language. A new section on
  44. techniques answers frequently-asked questions about ARexx with
  45. example code that can often be plugged directly into a script. Each
  46. possible error code is explained.
  47.  
  48. Notes on compatability issues have been added throughout the guide.
  49. They show how ARexx differs from the standard definition of REXX
  50. and offer methods for handling the differences.
  51.  
  52. RQ version ======================
  53.  
  54. Two different versions of the second edition are distributed. Both
  55. include the same information, but present it in somewhat different
  56. ways. The RQ version uses requesters to show definitions and other
  57. information that is displayed in the standard version by moving to
  58. a new node. The RQ version uses `rexxreqtools.library' by Rafael
  59. D'Halleweyn. and `ReqTools' by Nico François to implement the
  60. requesters. Because the requesters must be able to communicate with
  61. AmigaGuide through ARexx, this version can be used only with
  62. pre-MultiView versions of AmigaGuide -- that is, with version 34 of
  63. the library.
  64.  
  65.  REQUIREMENTS
  66.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  67. For the standard version: (ARexxGuide2_0A.lha)
  68.     Any AmigaGuide viewer.
  69.  
  70.     Multiview can be used with OS 3.x. Users of OS 1.3 or 2.x will
  71.     need the AmigaGuide utility and amigaguide.library which are
  72.     distributed by Commodore on most BBSes and networks that support
  73.     the Amiga.
  74.  
  75. For the RQ version: (ARexxGuide2_0rqA.lha)
  76.     AmigaGuide version 34 viewer and library.
  77.  
  78.     `reqtools.library' and `rexxreqtools.library'.
  79.  
  80.     These libraries are included in the distribution archives for
  81.     ReqTools by Nico François. Look for `ReqTools22a_User.lha' on
  82.     your favorite shareware source. A minimum version of 37.5 for
  83.     rexxreqtools.library is required.
  84.  
  85.  ARCHIVE CONTENTS
  86.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  87. The ARexxGuide drawer of this archive contains 21 files that make
  88. up one AmigaGuide® application. The AmigaGuide files are:
  89.  
  90.   ArexxGuide.guide
  91.   ARx_Cmd.ag
  92.   ARx_Elements.ag
  93.   ARx_Elements2.ag
  94.   ARx_Elements3.ag
  95.   ARx_Func.ag
  96.   ARx_Func2.ag
  97.   ARx_Func3.ag
  98.   ARx_Func4.ag
  99.   ARx_Guide.xref
  100.   ARx_Index
  101.   ARx_Instr.ag
  102.   ARx_Instr2.ag
  103.   ARx_Instr3.ag
  104.   ARx_Intro.ag
  105.   ARx_Operator.ag
  106.   ARx_PrgUcr.ag
  107.   ARx_Tknq.ag
  108.   ARx_Tutor.ag
  109.   ARx_UcrTutor1.ag
  110.   ARx_UcrTutor2.ag
  111.  
  112. Only ARexxGuide.guide is intended as an AmigaGuide executable. The
  113. other files are called from within the main node of that guide.
  114.  
  115. The following ARexx script files, located in the same directory,
  116. are used to run interactive examples from ARexxGuide, or to provide
  117. utilities for the program:
  118.  
  119.   ARexxGuide.rexx
  120.   ARx_Cmpr.rexx
  121.   ARx_IactExamples.rexx
  122.   ARx_Reg.rexx
  123.   ARx_Setup.rexx
  124.   Arx_Trace.rexx
  125.  
  126. Two additional files are included with the RQ version of the guide.
  127.  
  128.   ARx_Glossary.rexx
  129.   ARx_GlossaryPort.rexx
  130.  
  131. The `Editors' drawer contains macros for the ARexxGuide help
  132. system. Example macros are included for Ed 2.0 (the editor that
  133. comes with the OS), TurboText, and Edge. A tutorial in ARexxGuide
  134. explains how to make a file for a different editor. Any editor that
  135. is capable of minimal communication with ARexx can be used.
  136.  
  137. The 'Extras' drawer contains some files that are not necessary, but
  138. may be helpful to some users. Read the opening comment for more
  139. information.
  140.  
  141. The file 'UnCrunch.rexx' is the the source document for the program
  142. included in the tutorial section.
  143.  
  144.  DISTRIBUTION
  145.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  146. The files in this archive are copyright © 1993,1994 by Robin Evans
  147. and may be distributed only in the original form and only under the
  148. conditions outlined below.
  149.  
  150. Distribution of the material in this archive is prohibited if the
  151. contents of the original archive are altered in any way.
  152.  
  153. The archive may be distributed in its original form on local and
  154. national computer networks, on Aminet distribution channels
  155. (including the Walnut Creek CD-ROM), on Fish collections, or on
  156. disk collections distributed by non-profit entities. Distribution
  157. by other means (including distribution by profit-making entities
  158. other than those mentioned) is prohibited unless specific
  159. permission is granted.
  160.  
  161. Rights are reserved for other forms of distribution of this archive
  162. or of its contents individually, including but not limited to
  163. distribution of a printed version of any file contained in the
  164. archive, distribution with commercial products, or distribution on
  165. computer networks in hypertext form of any file in the archive.
  166. Contact the author for further information and permissions.
  167.  
  168.                Robin Evans                   10 Apr 1994
  169.  
  170.                   from Internet:
  171.                      robin@halcyon.com
  172.                      r.evans6@genie.geis.com
  173.  
  174.                   on GEnie:
  175.                      R.EVANS6
  176.  
  177.                   by phone:
  178.                      (206) 682-7077
  179.  
  180.  
  181. ============================= Archive contents =============================
  182.  
  183. Original  Packed Ratio    Date     Time    Name
  184. -------- ------- ----- --------- --------  -------------
  185.    60142   14446 75.9% 05-Apr-94 10:46:24  ARexxGuide/ARexxGuide.guide
  186.      488     250 48.7% 23-Mar-94 14:03:36  ARexxGuide/ARexxGuide.guide.info
  187.     2368    1346 43.1% 23-Mar-94 14:03:36  ARexxGuide/ARexxGuide.info
  188.     7969    3230 59.4% 10-Apr-94 13:39:28  ARexxGuide/ARexxGuide.rexx
  189.     2075     715 65.5% 23-Mar-94 17:33:42  ARexxGuide/ARexxGuide.rexx.info
  190.    22321    7931 64.4% 05-Apr-94 10:47:36  ARexxGuide/ARx_Cmd.ag
  191.     3412    1501 56.0% 12-Mar-94 19:07:04  ARexxGuide/ARx_Cmpr.rexx
  192.     2075     719 65.3% 23-Mar-94 14:03:36  ARexxGuide/ARx_Cmpr.rexx.info
  193.    31816   11080 65.1% 05-Apr-94 10:49:28  ARexxGuide/ARx_Elements.ag
  194.    40687   13782 66.1% 06-Apr-94 16:34:00  ARexxGuide/ARx_Elements2.ag
  195.    46092   15911 65.4% 06-Apr-94 16:34:30  ARexxGuide/ARx_Elements3.ag
  196.    38703   11407 70.5% 05-Apr-94 10:52:22  ARexxGuide/ARx_Error.ag
  197.    40988   11006 73.1% 05-Apr-94 10:55:32  ARexxGuide/ARx_Func.ag
  198.    48021   13170 72.5% 06-Apr-94 16:35:32  ARexxGuide/ARx_Func2.ag
  199.    59265   17333 70.7% 06-Apr-94 16:35:54  ARexxGuide/ARx_Func3.ag
  200.    36965    9012 75.6% 06-Apr-94 16:36:10  ARexxGuide/ARx_Func4.ag
  201.      940     453 51.8% 23-Mar-94 10:56:06  ARexxGuide/ARx_Glossary.rexx
  202.     2075     716 65.4% 23-Mar-94 14:03:36  ARexxGuide/ARx_Glossary.rexx.info
  203.    23455    8023 65.7% 10-Apr-94 14:16:08  ARexxGuide/ARx_GlossaryPort.rexx
  204.     2075     715 65.5% 24-Mar-94 11:16:10  ARexxGuide/ARx_GlossaryPort.rexx.info
  205.    11907    1851 84.4% 21-Mar-94 15:30:54  ARexxGuide/ARx_Guide.xref
  206.    20460    7358 64.0% 02-Apr-94 14:51:34  ARexxGuide/ARx_IactExamples.rexx
  207.     2075     720 65.3% 23-Mar-94 14:03:36  ARexxGuide/ARx_IactExamples.rexx.info
  208.    63447   12373 80.4% 06-Apr-94 18:03:06  ARexxGuide/ARx_Index
  209.    44879   14274 68.1% 27-Mar-94 12:08:56  ARexxGuide/ARx_Instr.ag
  210.    47005   14409 69.3% 06-Apr-94 16:36:54  ARexxGuide/ARx_Instr2.ag
  211.    50049   16308 67.4% 06-Apr-94 16:37:48  ARexxGuide/ARx_Instr3.ag
  212.    31208   12396 60.2% 23-Mar-94 12:15:48  ARexxGuide/ARx_Intro.ag
  213.    17850    5728 67.9% 23-Mar-94 12:15:52  ARexxGuide/ARx_Operator.ag
  214.     7586    2411 68.2% 05-Apr-94 11:07:48  ARexxGuide/ARx_PrgUcr.ag
  215.    11078    3614 67.3% 02-Apr-94 14:49:44  ARexxGuide/ARx_RarpInfoWin.rexx
  216.     2075     716 65.4% 23-Mar-94 14:03:36  ARexxGuide/ARx_RarpInfoWin.rexx.info
  217.     8014    3323 58.5% 21-Mar-94 13:39:38  ARexxGuide/ARx_Reg.rexx
  218.     2075     721 65.2% 23-Mar-94 14:03:36  ARexxGuide/ARx_Reg.rexx.info
  219.    26036    8681 66.6% 06-Apr-94 16:27:16  ARexxGuide/ARx_Setup.rexx
  220.     2346    1328 43.3% 23-Mar-94 14:03:36  ARexxGuide/ARx_Setup.rexx.info
  221.    72608   24104 66.8% 06-Apr-94 16:27:48  ARexxGuide/ARx_Tknq.ag
  222.    10862    4180 61.5% 24-Mar-94 14:45:22  ARexxGuide/Arx_Trace.rexx
  223.     2075     721 65.2% 23-Mar-94 14:03:36  ARexxGuide/Arx_Trace.rexx.info
  224.    15749    5168 67.1% 06-Apr-94 16:38:56  ARexxGuide/ARx_UcrTutor1.ag
  225.    17778    5654 68.1% 06-Apr-94 16:39:12  ARexxGuide/ARx_UcrTutor2.ag
  226.     2827    1373 51.4% 05-Apr-94 09:49:08  ARexxGuide/ARxG_20patch.readme
  227.     2075     716 65.4% 05-Apr-94 09:51:48  ARexxGuide/ARxG_20patch.readme.info
  228.      948     342 63.9% 24-Mar-94 16:00:36  ARexxGuide/Editors.info
  229.    20519    6715 67.2% 30-Mar-94 11:23:30  ARexxGuide/Editors/ARx_Help.ed
  230.     2075     714 65.5% 23-Mar-94 13:45:40  ARexxGuide/Editors/ARx_Help.ed.info
  231.    17934    5979 66.6% 30-Mar-94 11:22:52  ARexxGuide/Editors/ARx_Help.edge
  232.     2749     950 65.4% 23-Mar-94 13:45:40  ARexxGuide/Editors/ARx_Help.edge.info
  233.    19155    6221 67.5% 30-Mar-94 11:24:10  ARexxGuide/Editors/ARx_Help.ttx
  234.      778     366 52.9% 23-Mar-94 13:45:42  ARexxGuide/Editors/ARx_Help.ttx.info
  235.     4368    1661 61.9% 23-Mar-94 13:44:04  ARexxGuide/Editors/ARx_HelpSystem.README
  236.     2075     715 65.5% 23-Mar-94 13:45:42  ARexxGuide/Editors/ARx_HelpSystem.README.info
  237.      200     153 23.5% 23-Mar-94 13:24:40  ARexxGuide/Editors/Ed-startup
  238.     2075     717 65.4% 23-Mar-94 13:45:40  ARexxGuide/Editors/Ed-startup.info
  239.      948     343 63.8% 24-Mar-94 16:00:36  ARexxGuide/Extras.info
  240.     3983    1776 55.4% 23-Mar-94 13:29:04  ARexxGuide/Extras/ARx_Help.rexx
  241.     2075     716 65.4% 23-Mar-94 13:30:30  ARexxGuide/Extras/ARx_Help.rexx.info
  242.     5870    2434 58.5% 24-Mar-94 11:39:22  ARexxGuide/Extras/ARx_MakeNodeList.rexx
  243.     2075     715 65.5% 24-Mar-94 11:16:10  ARexxGuide/Extras/ARx_MakeNodeList.rexx.info
  244.     2846    1156 59.3% 24-Mar-94 15:11:18  ARexxGuide/Extras/UnCrunch.rexx
  245.     2075     715 65.5% 24-Mar-94 15:13:14  ARexxGuide/Extras/UnCrunch.rexx.info
  246.      948     338 64.3% 23-Mar-94 14:03:36  ARexxGuide.info
  247.    12295    4677 61.9% 10-Apr-94 16:18:30  ARexxGuide/ARexxGuide2_0rqA.readme
  248.     2075     713 65.6% 24-Mar-94 16:00:52  ARexxGuide/ARexxGuide2_0rqA.readme.info
  249.    55211   18726 66.0% 10-Apr-94 16:54:48  ARexxGuide/ARx_Tutor.ag
  250. -------- ------- ----- --------- --------
  251.  1107273  347715 68.5% 11-Apr-94 15:56:02   65 files
  252.